Found a problem we need to address, see NiklasRosenstein/pydoc-markdown#308

Found a problem we need to address, see NiklasRosenstein/pydoc-markdown#308

Enforcing the docstring style to sphinx did help for the code sample formatting problem.

Fixes also #1771

Could be merged, any comments?

Do we need an action that checks for changed but uncommited docs? As the precommit hook must be activated manually and could be forgotten (like flake8).

The action could run "./run_docgeneration.sh" and fail the build if there a outgoing changes?

Do we need an action that checks for changed but uncommited docs? As the precommit hook must be activated manually and could be forgotten (like flake8).

The action could run "./run_docgeneration.sh" and fail the build if there a outgoing changes?

I would suggest the following:

• keep the current pre commit hook, so devs can already check their changes
• in addition add a GitHub Action in case someone didn't activate pre commit hooks (similar to flake8 behavior)

My question would be, should I extend the Python action or add another one? What do you think?

Discussion about action OR hook was already in #2159

Extending the current action would be fine for me.

Would you also add flake8-docstrings like mentioned in #2159?

I would add flake8-docstrings in a separate PR. Right now there are many warnings, which would fix in this separate PR.

Added a check in the action. Needs more testing, though.

The action does not work as expected, therefore I will add the integration into the Python action in a separate PR later.

Otherwise it could be merged from my point of view.